<!DOCTYPE html>
<html lang="en-US">
    <head>
        <title>Encode::Locale - Determine the locale encoding - metacpan.org</title>
        <link rel="preload" as="fetch" href="https://metacpan.org/account/login_status" crossorigin="anonymous" />
        <link href="https://metacpan.org/_assets/b8ccceeed47a0652049703d99326a9cea4933443.css" rel="stylesheet" type="text/css">
        <script src="https://metacpan.org/_assets/6bfedafe2d7caa915b7d84f61b45936818e3242e.js" type="text/javascript" defer></script>
        <link rel="alternate" type="application/rss+xml" title="Recent CPAN Uploads of Encode-Locale - MetaCPAN" href="https://metacpan.org/dist/Encode-Locale/releases.rss" />
        <link rel="canonical" href="./Encode::Locale.html" />
        <meta name="description" content="Determine the locale encoding" />
        <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=5">
        <link rel="shortcut icon" href="https://metacpan.org/static/icons/favicon.ico">
        <link rel="apple-touch-icon" sizes="152x152" href="https://metacpan.org/static/icons/apple-touch-icon.png">
        <link rel="search" href="https://metacpan.org/static/opensearch.xml" type="application/opensearchdescription+xml" title="MetaCPAN">
        <script>
          (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
          (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
          m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
          })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

          (function(skey, ga_id){
            ga('create', ga_id, {
              siteSpeedSampleRate : 100,
              storage             : 'none',
              clientId            : localStorage.getItem(skey)
            });
            ga(function(tracker) {
              localStorage.setItem(skey, tracker.get('clientId'));
            });
            ga('send', 'pageview');
          })('ga:clientId', 'UA-27829474-1');
        </script>
<meta name="twitter:card"        content="summary" />
<meta name="twitter:url"         content="https://metacpan.org/pod/Encode::Locale" />
<meta name="twitter:title"       content="Encode::Locale" />
<meta name="twitter:description" content="Determine the locale encoding" />
<meta name="twitter:site"        content="metacpan" />
    </head>
    <body>
        <nav class="navbar navbar-default" role="navigation">
            <div class="header-logo-large hidden-xs">
              <a href="https://metacpan.org/" tabindex="0">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#logo" />
                </svg>
              </a>
            </div>
            <div class="header-logo-icon visible-xs">
              <a href="https://metacpan.org/">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#dots" />
                </svg>
              </a>
            </div>
            <ul class="nav navbar-nav menu-items hidden-xs hidden-sm">
              <li><a href="https://metacpan.org/about">About</a></li>
              <li><a href="https://metacpan.org/about/sponsors">Sponsor</a></li>
              <li><a href="https://grep.metacpan.org/">grep::cpan</a></li>
              <li><a href="https://metacpan.org/recent">Recent</a></li>
              <li><a href="https://metacpan.org/about/faq">FAQ</a></li>
              <li><a href="https://metacpan.org/tools">Tools</a></li>
              <li><a href="https://fastapi.metacpan.org/">API</a></li>
            </ul>
            <ul class="nav navbar-nav navbar-right">
                <button type="button" class="searchbar-btn visible-xs visible-sm">
                    <i class="fa fa-search button-fa-icon"></i>
                </button>
                <form action="https://metacpan.org/search" class="searchbar-form visible-md visible-lg search-form form-horizontal">
                   <input type="hidden" name="size" id="metacpan_search-size" value="20">
                  <div class="form-group">
                      <div class="search-group">
                        <i class="fa fa-search"></i>
                        <input type="text" name="q" placeholder="Search the CPAN" size="41" autocorrect="off" autocapitalize="off" spellcheck="false" id="metacpan_search-input" class="form-control" value="">
                      </div>
                  </div>
                </form>
                    <li class="icon-slidepanel visible-xs visible-sm">
                      <button data-toggle="slidepanel" data-target=".slidepanel">
                        <span class="button-fa-icon">
                          <i class="fa fa-bars slidepanel-open"></i>
                          <i class="fa fa-times slidepanel-close"></i>
                        </span>
                      </button>
                    </li>
                <form action="https://metacpan.org/account/logout" method="POST" id="metacpan-logout"></form>
                <li class="dropdown logged_in" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon logged-in-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li><a href="https://metacpan.org/account/identities">Identities</a></li>
                        <li><a href="https://metacpan.org/account/profile">Profile</a></li>
                        <li><a href="https://metacpan.org/account/favorite/list">Favorites</a></li>
                        <li>
                            <a href="./Encode::Locale.html#" type="button" onclick="$('#metacpan-logout').submit(); return false">
                              Logout
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_out" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li>
                            <a href="https://metacpan.org/login/github">
                                <i class="fab fa-github fa-fw"></i>
                                GitHub
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/twitter">
                                <i class="fab fa-twitter fa-fw"></i>
                                Twitter
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/google">
                                <i class="fab fa-google fa-fw"></i>
                                Google
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_placeholder">
                    <button>
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                    </button>
                </li>
            </ul>
        </nav>
        <div class="page-content ">
          <!--
          <div class="top-notify-banner">
            <i class="fas fa-info-circle"></i>
          </div>
          -->
          <nav class="sidebar">
            <div class="slidepanel">
              <ul class="nav-list ">
    <li class="nav-header no-margin-top">
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The date that this version of Encode-Locale was released.">
      <span class="relatize">09 Jun 2015 20:10:45 UTC</span>
    </li>
  <li>
    Distribution: <a href="https://metacpan.org/dist/Encode-Locale">Encode-Locale</a>
  </li>
  <li>
    Module version: 1.05
  </li>
  <li>
    <a data-keyboard-shortcut="g s" href="https://metacpan.org/dist/Encode-Locale/source/lib/Encode/Locale.pm">Source</a>
    (<a href="https://metacpan.org/dist/Encode-Locale/source/lib/Encode/Locale.pm?raw=1">raw</a>)
  </li>
  <li>
    <a data-keyboard-shortcut="g b" href="https://metacpan.org/dist/Encode-Locale/source/lib/Encode">Browse</a>
    (<a href="https://metacpan.org/dist/Encode-Locale/source/lib/Encode?raw=1">raw</a>)
  </li>
    <li>
      <a data-keyboard-shortcut="g c" href="https://metacpan.org/dist/Encode-Locale/changes">Changes</a>
    </li>
    <li>
      <a class="nopopup" href="https://metacpan.org/dist/Encode-Locale/contribute">How to Contribute</a>
    </li>
    <li>
        <a rel="noopener nofollow" data-keyboard-shortcut="g r" href="https://github.com/gisle/encode-locale">Repository</a>
    </li>
    <li>
      <a rel="noopener nofollow" data-keyboard-shortcut="g i" href="https://rt.cpan.org/Public/Dist/Display.html?Name=Encode-Locale">Issues</a>
      (1)
    </li>
    <li>
      <a rel="noopener nofollow" href="http://matrix.cpantesters.org/?dist=Encode-Locale+1.05" title="Matrix">Testers</a>
        <span title="(pass / fail / na)">(<a rel="noopener nofollow" href="https://www.cpantesters.org/distro/E/Encode-Locale.html?oncpan=1&amp;distmat=1&amp;version=1.05&amp;grade=2" style="color: #090">1460</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/E/Encode-Locale.html?oncpan=1&amp;distmat=1&amp;version=1.05&amp;grade=3" style="color: #900">1</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/E/Encode-Locale.html?oncpan=1&amp;distmat=1&amp;version=1.05&amp;grade=4">2</a>)</span>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpants.cpanauthors.org/release/GAAS/Encode-Locale-1.05">Kwalitee</a>
    </li>
    <li>
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The # people with an indexing permission on Encode-Locale who have released something to CPAN in the last 2 years (i.e. the # people likely able to release critical fixes in a timely manner)">
      Bus factor: 0
      </div>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpancover.com/latest/Encode-Locale-1.05/index.html">44.19% Coverage </a>
    </li>
    <li>
      License: perl_5
    </li>
    <li>
      Perl: v5.8.0
    </li>
    <li class="nav-header">Activity</li>
    <li>
<div class="activity-graph">
    <img src="https://metacpan.org/dist/Encode-Locale/activity.svg?res=month" />
    <div class="comment">24 month</div>
</div>
    </li>
    <li class="nav-header">Tools</li>
    <li>
      <a itemprop="downloadUrl" href="https://cpan.metacpan.org/authors/id/G/GA/GAAS/Encode-Locale-1.05.tar.gz">
      Download (<span itemprop="fileSize">8.16KB</span>)</a>
    </li>
    <li>
      <a href="https://explorer.metacpan.org/?url=%2Fmodule%2FGAAS%2FEncode-Locale-1.05%2Flib%2FEncode%2FLocale.pm">
        MetaCPAN Explorer
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/Encode-Locale/permissions">
        Permissions
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/Encode-Locale/releases.rss">
        Subscribe to distribution
      </a>
    </li>
    <li>
      <button class="btn btn-link" data-toggle="modal" data-target="#metacpan_install-instructions-dialog">
        Install Instructions
      </button>
    </li>
    <li>
      <form action="https://metacpan.org/search">
        <input type="hidden" name="q" value="dist:Encode-Locale">
        <input type="search" name="q" placeholder="Search distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
      </form>
    </li>
    <li>
      <form action="https://grep.metacpan.org/search">
        <input type="hidden" name="qd" value="Encode-Locale">
        <input type="hidden" name="source" value="metacpan">
        <input type="search" name="q" placeholder="grep distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
     </form>
    </li>
    <li class="version-jump">
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/lib/Encode/Locale.pm&#39;" class="form-control tool-bar-form">
  <option disabled selected>Jump to version</option>
<option
  disabled
  value="GAAS/Encode-Locale-1.05"
>1.05
  (GAAS on 2015-06-09)</option>
<option
  
  value="GAAS/Encode-Locale-1.04"
>1.04
  (GAAS on 2015-01-12)</option>
<option
  
  value="GAAS/Encode-Locale-1.03"
>1.03
  (GAAS on 2012-02-11)</option>
<optgroup label="BackPAN">'
<option
  
  value="GAAS/Encode-Locale-1.02"
>1.02
  (GAAS on 2011-03-28)</option>
<option
  
  value="GAAS/Encode-Locale-1.01"
>1.01
  (GAAS on 2011-02-22)</option>
<option
  
  value="GAAS/Encode-Locale-1.00"
>1.00
  (GAAS on 2011-01-23)</option>
<option
  
  value="GAAS/Encode-Locale-0.04"
>0.04
  (GAAS on 2010-11-23)</option>
<option
  
  value="GAAS/Encode-Locale-0.03"
>0.03
  (GAAS on 2010-11-20)</option>
<option
  
  value="GAAS/Encode-Locale-0.02"
>0.02
  (GAAS on 2010-11-13)</option>
<option
  
  value="GAAS/Encode-Locale-0.01"
>0.01
  (GAAS on 2010-11-11)</option>
</optgroup>
</select>
    </li>
    <li class="version-diff">
<select onchange="document.location.href='/release/GAAS/Encode-Locale-1.05/diff/' + encodeURIComponent(this.value) + '/lib/Encode/Locale.pm'
" class="form-control tool-bar-form">
  <option disabled selected>Diff with version</option>
<option
  disabled
  value="GAAS/Encode-Locale-1.05"
>1.05
  (GAAS on 2015-06-09)</option>
<option
  
  value="GAAS/Encode-Locale-1.04"
>1.04
  (GAAS on 2015-01-12)</option>
<option
  
  value="GAAS/Encode-Locale-1.03"
>1.03
  (GAAS on 2012-02-11)</option>
<optgroup label="BackPAN">'
<option
  
  value="GAAS/Encode-Locale-1.02"
>1.02
  (GAAS on 2011-03-28)</option>
<option
  
  value="GAAS/Encode-Locale-1.01"
>1.01
  (GAAS on 2011-02-22)</option>
<option
  
  value="GAAS/Encode-Locale-1.00"
>1.00
  (GAAS on 2011-01-23)</option>
<option
  
  value="GAAS/Encode-Locale-0.04"
>0.04
  (GAAS on 2010-11-23)</option>
<option
  
  value="GAAS/Encode-Locale-0.03"
>0.03
  (GAAS on 2010-11-20)</option>
<option
  
  value="GAAS/Encode-Locale-0.02"
>0.02
  (GAAS on 2010-11-13)</option>
<option
  
  value="GAAS/Encode-Locale-0.01"
>0.01
  (GAAS on 2010-11-11)</option>
</optgroup>
</select>
    </li>

    <li>
<ul class="dependencies">
  <li class="nav-header">Dependencies</li>
  <li><a href="https://metacpan.org/pod/Encode" title="Encode" class="ellipsis">Encode</a></li>
  <li><a href="https://metacpan.org/pod/Encode::Alias" title="Encode::Alias" class="ellipsis">Encode::Alias</a></li>
  <li><i class="ttip" title="dynamic_config enabled">and possibly others</i></li>
  <li>
    <hr>
  </li>
  <li>
    <a href="https://metacpan.org/module/Encode::Locale/requires">Reverse dependencies</a>
  </li>
  <li>
    <a href="http://deps.cpantesters.org/?module=Encode%3A%3ALocale">CPAN Testers List</a>
  </li>
  <li>
    <a href="https://cpandeps.grinnz.com/?dist=Encode-Locale">Dependency graph</a>
  </li>
</ul>
    </li>
    <li class="nav-header">Permalinks</li>
    <li>
      <a href="https://metacpan.org/release/GAAS/Encode-Locale-1.05/view/lib/Encode/Locale.pm">This version</a>
    </li>
    <li>
      <a href="./Encode::Locale.html">Latest version</a>
    </li>
    <li>
<div class="plussers">
<div class="nav-header">++ed by:</div>
<div>
<a class="display-all" href="https://metacpan.org/author/KEEDI"><img src="https://www.gravatar.com/avatar/95f905a7a4ccc573c711e9d264c0fde8?d=identicon&amp;s=20" title="KEEDI" alt="KEEDI"></a>
<a class="display-all" href="https://metacpan.org/author/MICHIELB"><img src="https://www.gravatar.com/avatar/c35b97da3835376f2d804b022121f962?d=identicon&amp;s=20" title="MICHIELB" alt="MICHIELB"></a>
<a class="display-all" href="https://metacpan.org/author/KUERBIS"><img src="https://www.gravatar.com/avatar/136c77354b6a6d4451c38198dd74d83c?d=identicon&amp;s=20" title="KUERBIS" alt="KUERBIS"></a>
</div>
<!-- Display counts of plussers-->
<div>
    <a href="https://metacpan.org/dist/Encode-Locale/plussers">3 PAUSE users</a>
</div>
<div>
    9 non-PAUSE users
</div>
</div>
    </li>
    <li>
<div id="metacpan_contributors">
  <div>
    <button class="btn-link"
      onclick="$(this).hide(); $('#metacpan_contributors ul').slideDown(); return false;"
    >and 1 contributors</button>
  </div>
  <ul style="display: none">
    <li class="contributor"
      data-contrib-email="gisle@activestate.com"
    >
      <img class="gravatar" width="20" height="20" src="https://www.gravatar.com/avatar/d41d8cd98f00b204e9800998ecf8427e?d=identicon&amp;s=20" />
      Gisle Aas
    </li>
  </ul>
</div>
    </li>
              </ul>
            </div>
          </nav>
          <div class="content-navigation">
<div class="breadcrumbs">
  <span>
    <a data-keyboard-shortcut="g a" rel="author" href="https://metacpan.org/author/GAAS" class="author-name">Gisle Aas</a>
  </span>
  <span>&nbsp;/&nbsp;</span>
  <div class="release dist-release status-latest maturity-released">
    <span class="dropdown"><b class="caret"></b></span>
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/lib/Encode/Locale.pm&#39;" class="">
<option
  selected
  value="GAAS/Encode-Locale-1.05"
>1.05
  (GAAS on 2015-06-09)</option>
<option
  
  value="GAAS/Encode-Locale-1.04"
>1.04
  (GAAS on 2015-01-12)</option>
<option
  
  value="GAAS/Encode-Locale-1.03"
>1.03
  (GAAS on 2012-02-11)</option>
<optgroup label="BackPAN">'
<option
  
  value="GAAS/Encode-Locale-1.02"
>1.02
  (GAAS on 2011-03-28)</option>
<option
  
  value="GAAS/Encode-Locale-1.01"
>1.01
  (GAAS on 2011-02-22)</option>
<option
  
  value="GAAS/Encode-Locale-1.00"
>1.00
  (GAAS on 2011-01-23)</option>
<option
  
  value="GAAS/Encode-Locale-0.04"
>0.04
  (GAAS on 2010-11-23)</option>
<option
  
  value="GAAS/Encode-Locale-0.03"
>0.03
  (GAAS on 2010-11-20)</option>
<option
  
  value="GAAS/Encode-Locale-0.02"
>0.02
  (GAAS on 2010-11-13)</option>
<option
  
  value="GAAS/Encode-Locale-0.01"
>0.01
  (GAAS on 2010-11-11)</option>
</optgroup>
</select>
    <a data-keyboard-shortcut="g d" class="release-name" href="https://metacpan.org/dist/Encode-Locale">Encode-Locale-1.05</a>
  </div>
<span class="river-gauge-gauge">
  <svg width="24px"
       height="15px"
       version="1.1"
       xmlns="http://www.w3.org/2000/svg"
       xmlns:xlink="http://www.w3.org/1999/xlink">

    <g>
      <title>        River stage four &#10;
          • 54 direct dependents &#10;          • 8588 total dependents
      </title>

      <rect x="0"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="5"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="10"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="15"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="20"  y="0" width="4" height="15" fill="#e4e2e2" />
    </g>
  </svg>

</span>
<div id="Encode-Locale-fav" class="logged_in">
<form action="https://metacpan.org/account/favorite/add" style="display: inline" onsubmit="return favDistribution(this)">
    <input type="hidden" name="remove" value="0">
    <input type="hidden" name="release" value="Encode-Locale-1.05">
    <input type="hidden" name="author" value="GAAS">
    <input type="hidden" name="distribution" value="Encode-Locale">
    <button type="submit" class="favorite highlight"><span>12</span> ++</button>
</form>
</div>
<div class="logged_out">
<a href="./Encode::Locale.html" onclick="alert('Please sign in to add favorites'); return false" class="favorite highlight">
<span>12</span> ++</a>
</div>
   / <span>Encode::Locale</span>
</div>
          </div>
          <main class="content">


<nav class="toc">
  <div class="toc-header"><strong>Contents</strong></div>
<ul>
  <li><a href="./Encode::Locale.html#NAME">NAME</a></li>
  <li><a href="./Encode::Locale.html#SYNOPSIS">SYNOPSIS</a></li>
  <li><a href="./Encode::Locale.html#DESCRIPTION">DESCRIPTION</a></li>
  <li><a href="./Encode::Locale.html#NOTES">NOTES</a>
    <ul>
      <li><a href="./Encode::Locale.html#Windows">Windows</a></li>
      <li><a href="./Encode::Locale.html#Mac-OS-X">Mac OS X</a></li>
      <li><a href="./Encode::Locale.html#POSIX-(Linux-and-other-Unixes)">POSIX (Linux and other Unixes)</a></li>
    </ul>
  </li>
  <li><a href="./Encode::Locale.html#SEE-ALSO">SEE ALSO</a></li>
  <li><a href="./Encode::Locale.html#AUTHOR">AUTHOR</a></li>
</ul></nav>
<div class="pod anchors">
<h1 id="NAME">NAME</h1>

<p>Encode::Locale - Determine the locale encoding</p>

<h1 id="SYNOPSIS">SYNOPSIS</h1>

<pre><code>  use Encode::Locale;
  use Encode;

  $string = decode(locale =&gt; $bytes);
  $bytes = encode(locale =&gt; $string);

  if (-t) {
      binmode(STDIN, &quot;:encoding(console_in)&quot;);
      binmode(STDOUT, &quot;:encoding(console_out)&quot;);
      binmode(STDERR, &quot;:encoding(console_out)&quot;);
  }

  # Processing file names passed in as arguments
  my $uni_filename = decode(locale =&gt; $ARGV[0]);
  open(my $fh, &quot;&lt;&quot;, encode(locale_fs =&gt; $uni_filename))
     || die &quot;Can&#39;t open &#39;$uni_filename&#39;: $!&quot;;
  binmode($fh, &quot;:encoding(locale)&quot;);
  ...</code></pre>

<h1 id="DESCRIPTION">DESCRIPTION</h1>

<p>In many applications it&#39;s wise to let Perl use Unicode for the strings it processes. Most of the interfaces Perl has to the outside world are still byte based. Programs therefore need to decode byte strings that enter the program from the outside and encode them again on the way out.</p>

<p>The POSIX locale system is used to specify both the language conventions requested by the user and the preferred character set to consume and output. The <code>Encode::Locale</code> module looks up the charset and encoding (called a CODESET in the locale jargon) and arranges for the <a href="https://metacpan.org/pod/Encode">Encode</a> module to know this encoding under the name &quot;locale&quot;. It means bytes obtained from the environment can be converted to Unicode strings by calling <code>Encode::encode(locale =&gt; $bytes)</code> and converted back again with <code>Encode::decode(locale =&gt; $string)</code>.</p>

<p>Where file systems interfaces pass file names in and out of the program we also need care. The trend is for operating systems to use a fixed file encoding that don&#39;t actually depend on the locale; and this module determines the most appropriate encoding for file names. The <a href="https://metacpan.org/pod/Encode">Encode</a> module will know this encoding under the name &quot;locale_fs&quot;. For traditional Unix systems this will be an alias to the same encoding as &quot;locale&quot;.</p>

<p>For programs running in a terminal window (called a &quot;Console&quot; on some systems) the &quot;locale&quot; encoding is usually a good choice for what to expect as input and output. Some systems allows us to query the encoding set for the terminal and <code>Encode::Locale</code> will do that if available and make these encodings known under the <code>Encode</code> aliases &quot;console_in&quot; and &quot;console_out&quot;. For systems where we can&#39;t determine the terminal encoding these will be aliased as the same encoding as &quot;locale&quot;. The advice is to use &quot;console_in&quot; for input known to come from the terminal and &quot;console_out&quot; for output to the terminal.</p>

<p>In addition to arranging for various Encode aliases the following functions and variables are provided:</p>

<dl>

<dt id="decode_argv(-)"><a id="decode_argv"></a>decode_argv( )</dt>
<dd>

</dd>
<dt id="decode_argv(-Encode::FB_CROAK-)"><a id="decode_argv1"></a><a id="decode_argv--Encode::FB_CROAK"></a>decode_argv( Encode::FB_CROAK )</dt>
<dd>

<p>This will decode the command line arguments to perl (the <code>@ARGV</code> array) in-place.</p>

<p>The function will by default replace characters that can&#39;t be decoded by &quot;\x{FFFD}&quot;, the Unicode replacement character.</p>

<p>Any argument provided is passed as CHECK to underlying Encode::decode() call. Pass the value <code>Encode::FB_CROAK</code> to have the decoding croak if not all the command line arguments can be decoded. See <a href="https://metacpan.org/pod/Encode#Handling-Malformed-Data">&quot;Handling Malformed Data&quot; in Encode</a> for details on other options for CHECK.</p>

</dd>
<dt id="env(-$uni_key-)"><a id="env"></a><a id="env---uni_key"></a>env( $uni_key )</dt>
<dd>

</dd>
<dt id="env(-$uni_key-=&gt;-$uni_value-)"><a id="env1"></a><a id="env---uni_key----uni_value"></a>env( $uni_key =&gt; $uni_value )</dt>
<dd>

<p>Interface to get/set environment variables. Returns the current value as a Unicode string. The $uni_key and $uni_value arguments are expected to be Unicode strings as well. Passing <code>undef</code> as $uni_value deletes the environment variable named $uni_key.</p>

<p>The returned value will have the characters that can&#39;t be decoded replaced by &quot;\x{FFFD}&quot;, the Unicode replacement character.</p>

<p>There is no interface to request alternative CHECK behavior as for decode_argv(). If you need that you need to call encode/decode yourself. For example:</p>

<pre><code>    my $key = Encode::encode(locale =&gt; $uni_key, Encode::FB_CROAK);
    my $uni_value = Encode::decode(locale =&gt; $ENV{$key}, Encode::FB_CROAK);</code></pre>

</dd>
<dt id="reinit(-)"><a id="reinit"></a>reinit( )</dt>
<dd>

</dd>
<dt id="reinit(-$encoding-)"><a id="reinit1"></a><a id="reinit---encoding"></a>reinit( $encoding )</dt>
<dd>

<p>Reinitialize the encodings from the locale. You want to call this function if you changed anything in the environment that might influence the locale.</p>

<p>This function will croak if the determined encoding isn&#39;t recognized by the Encode module.</p>

<p>With argument force $ENCODING_... variables to set to the given value.</p>

</dd>
<dt id="$ENCODING_LOCALE"><a id="ENCODING_LOCALE"></a>$ENCODING_LOCALE</dt>
<dd>

<p>The encoding name determined to be suitable for the current locale. <a href="https://metacpan.org/pod/Encode">Encode</a> know this encoding as &quot;locale&quot;.</p>

</dd>
<dt id="$ENCODING_LOCALE_FS"><a id="ENCODING_LOCALE_FS"></a>$ENCODING_LOCALE_FS</dt>
<dd>

<p>The encoding name determined to be suitable for file system interfaces involving file names. <a href="https://metacpan.org/pod/Encode">Encode</a> know this encoding as &quot;locale_fs&quot;.</p>

</dd>
<dt id="$ENCODING_CONSOLE_IN"><a id="ENCODING_CONSOLE_IN"></a>$ENCODING_CONSOLE_IN</dt>
<dd>

</dd>
<dt id="$ENCODING_CONSOLE_OUT"><a id="ENCODING_CONSOLE_OUT"></a>$ENCODING_CONSOLE_OUT</dt>
<dd>

<p>The encodings to be used for reading and writing output to the a console. <a href="https://metacpan.org/pod/Encode">Encode</a> know these encodings as &quot;console_in&quot; and &quot;console_out&quot;.</p>

</dd>
</dl>

<h1 id="NOTES">NOTES</h1>

<p>This table summarizes the mapping of the encodings set up by the <code>Encode::Locale</code> module:</p>

<pre><code>  Encode      |         |              |
  Alias       | Windows | Mac OS X     | POSIX
  ------------+---------+--------------+------------
  locale      | ANSI    | nl_langinfo  | nl_langinfo
  locale_fs   | ANSI    | UTF-8        | nl_langinfo
  console_in  | OEM     | nl_langinfo  | nl_langinfo
  console_out | OEM     | nl_langinfo  | nl_langinfo</code></pre>

<h2 id="Windows">Windows</h2>

<p>Windows has basically 2 sets of APIs. A wide API (based on passing UTF-16 strings) and a byte based API based a character set called ANSI. The regular Perl interfaces to the OS currently only uses the ANSI APIs. Unfortunately ANSI is not a single character set.</p>

<p>The encoding that corresponds to ANSI varies between different editions of Windows. For many western editions of Windows ANSI corresponds to CP-1252 which is a character set similar to ISO-8859-1. Conceptually the ANSI character set is a similar concept to the POSIX locale CODESET so this module figures out what the ANSI code page is and make this available as $ENCODING_LOCALE and the &quot;locale&quot; Encoding alias.</p>

<p>Windows systems also operate with another byte based character set. It&#39;s called the OEM code page. This is the encoding that the Console takes as input and output. It&#39;s common for the OEM code page to differ from the ANSI code page.</p>

<h2 id="Mac-OS-X"><a id="Mac"></a>Mac OS X</h2>

<p>On Mac OS X the file system encoding is always UTF-8 while the locale can otherwise be set up as normal for POSIX systems.</p>

<p>File names on Mac OS X will at the OS-level be converted to NFD-form. A file created by passing a NFC-filename will come in NFD-form from readdir(). See <a href="https://metacpan.org/pod/Unicode::Normalize">Unicode::Normalize</a> for details of NFD/NFC.</p>

<p>Actually, Apple does not follow the Unicode NFD standard since not all character ranges are decomposed. The claim is that this avoids problems with round trip conversions from old Mac text encodings. See <a href="./Encode::UTF8Mac.html">Encode::UTF8Mac</a> for details.</p>

<h2 id="POSIX-(Linux-and-other-Unixes)"><a id="POSIX"></a><a id="POSIX--Linux-and-other-Unixes"></a>POSIX (Linux and other Unixes)</h2>

<p>File systems might vary in what encoding is to be used for filenames. Since this module has no way to actually figure out what the is correct it goes with the best guess which is to assume filenames are encoding according to the current locale. Users are advised to always specify UTF-8 as the locale charset.</p>

<h1 id="SEE-ALSO"><a id="SEE"></a>SEE ALSO</h1>

<p><a href="https://metacpan.org/pod/I18N::Langinfo">I18N::Langinfo</a>, <a href="https://metacpan.org/pod/Encode">Encode</a>, <a href="./Term::Encoding.html">Term::Encoding</a></p>

<h1 id="AUTHOR">AUTHOR</h1>

<p>Copyright 2010 Gisle Aas &lt;gisle@aas.no&gt;.</p>

<p>This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.</p></div>

<div id="metacpan_install-instructions-dialog" class="modal fade">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
        <h4 class="modal-title">Module Install Instructions</h4>
      </div>
      <div class="modal-body">
        <p>To install Encode::Locale, copy and paste the appropriate command in to your terminal.</p>
        <p><a href="https://metacpan.org/dist/App-cpanminus/view/bin/cpanm">cpanm</a></p>
        <pre><code>cpanm Encode::Locale</code></pre>
        <p><a href="https://metacpan.org/pod/CPAN">CPAN shell</a></p>
        <pre><code>perl -MCPAN -e shell
install Encode::Locale</code></pre>
        <p>For more information on module installation, please visit <a href="https://www.cpan.org/modules/INSTALL.html">the detailed CPAN module installation guide</a>.</p>
      </div>
      <div class="modal-footer">
        <a href="./Encode::Locale.html#" data-dismiss="modal" class="btn">Close</a>
      </div>
    </div>
  </div>
</div>
          </main>
          <div class="content-pagination">
          </div>
        </div>
        <footer class="footer">
          <div class="footer-container">
            <div class="footer-social">
              <div class="footer-link footer-logo">
                <a href="https://metacpan.org/">
                  <img src="https://metacpan.org/static/images/metacpan-logo.svg" alt="MetaCPAN" />
                </a>
              </div>
              <a class="footer-social-link" href="https://github.com/metacpan">
                <i class="fab fa-github-square"></i>
              </a>
              <a class="footer-social-link" href="https://fosstodon.org/@metacpan">
                <i class="fab fa-mastodon"></i>
              </a>
            </div>
            <div class="footer-links">
              <div class="footer-link">
                  <a href="https://metacpan.org/about">About</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/sponsors">Sponsor</a>
              </div>
              <div class="footer-link">
                  <a href="https://grep.metacpan.org">grep::cpan</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/recent">Recent</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/faq">FAQ</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/tools">Tools</a>
              </div>
              <div class="footer-link">
                  <a href="https://fastapi.metacpan.org/">API</a>
              </div>
              <div class="footer-link">
                  <a href="https://www.perl.org/">Perl.org</a>
              </div>
            </div>
            <div class="footer-sponsors">
              <a class="footer-sponsor-link" target="_blank" href="https://www.bytemark.co.uk/" rel="noopener">
                <img class="footer-sponsor-bytemark" src="https://metacpan.org/static/images/sponsors/bytemark_logo.svg" alt="Bytemark logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.liquidweb.com/" rel="noopener">
                <img class="footer-sponsor-liquidweb" src="https://metacpan.org/static/images/sponsors/liquidweb_logo.png" alt="liquidweb logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://deriv.com/careers/" rel="noopener">
                <img class="footer-sponsor-deriv" src="https://metacpan.org/static/images/sponsors/deriv.svg" alt="Deriv logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://geocode.xyz" rel="noopener">
                <img class="footer-sponsor-geocode" src="https://metacpan.org/static/images/sponsors/geocodelogo.svg" alt="Geocode logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.fastly.com/" rel="noopener">
                <img class="footer-sponsor-fastly" src="https://metacpan.org/static/images/sponsors/fastly_logo.svg" alt="Fastly logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://opencagedata.com" rel="noopener">
                <img class="footer-sponsor-opencage" src="https://metacpan.org/static/images/sponsors/open-cage.svg" alt="OpenCage logo">
              </a>
            </div>
          </div>
        </footer>
        <div class="modal fade" tabindex="-1" role="dialog" id="metacpan_keyboard-shortcuts">
          <div class="modal-dialog">
            <div class="modal-content">
              <div class="modal-header">
                <button type="button" class="close" data-dismiss="modal">&times;</button>
                <h4 class="modal-title">Keyboard Shortcuts</h4>
              </div>
              <div class="modal-body row">
<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Global</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>s</kbd>
        </td>
        <td>Focus search bar</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>?</kbd>
        </td>
        <td>Bring up this help dialog</td>
      </tr>
    </tbody>
  </table>

  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>GitHub</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>p</kbd>
        </td>
        <td>Go to pull requests</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>go to github issues (only if github is preferred repository)</td>
      </tr>
    </tbody>
  </table>
</div>

<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>POD</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>a</kbd>
        </td>
        <td>Go to author</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>c</kbd>
        </td>
        <td>Go to changes</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>Go to issues</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>d</kbd>
        </td>
        <td>Go to dist</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>r</kbd>
        </td>
        <td>Go to repository/SCM</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>s</kbd>
        </td>
        <td>Go to source</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>b</kbd>
        </td>
        <td>Go to file browse</td>
      </tr>

    </tbody>
  </table>
</div>

<div class="col-md-12">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Search terms</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><em>module:</em> (e.g. <a href="https://metacpan.org/search?q=module%3APlugin">module:Plugin</a>)</td>
      </tr>
      <tr>
        <td><em>distribution:</em> (e.g. <a href="https://metacpan.org/search?q=distribution%3ADancer+auth">distribution:Dancer auth</a>)</td>
      </tr>
      <tr>
        <td><em>author:</em> (e.g. <a href="https://metacpan.org/search?q=author%3ASONGMU+Redis">author:SONGMU Redis</a>)</td>
      </tr>
      <tr>
        <td><em>version:</em> (e.g. <a href="https://metacpan.org/search?q=version%3A1.00">version:1.00</a>)</td>
      </tr>
    </tbody>
  </table>
</div>
              </div>
              <div class="modal-footer"></div>
            </div>
          </div>
        </div>
    </body>
</html>
